Skip to content

[DO] Updating what methods can be applied to .exec().raw() #21919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 23, 2025
Merged

[DO] Updating what methods can be applied to .exec().raw() #21919

merged 1 commit into from
Apr 23, 2025

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Apr 23, 2025 •
edited
Loading

Summary

Previously, docs said you could apply all three (.toArray, .next, and .one) methods to the .raw().

However, .raw() does not support .one().

Updating docs to fix.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added size/xs product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ labels Apr 23, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 23, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Updated documentation to correct the functionality of the raw() method in the storage API.

  • Removed incorrect reference to one() method in the context of raw() functionality.
  • Clarified the methods supported by the returned Iterator from raw() to exclude one().

Modified Files

  • src/content/docs/durable-objects/api/storage-api.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@Oxyjun Oxyjun changed the title [DO] Removing docs where it said raw() can also return [DO] Updating what methods can be applied to .exec().raw() Apr 23, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Apr 23, 2025

Preview URL: https://720a685f.preview.developers.cloudflare.com
Preview Branch URL: https://jun-do-raw-iterator-docs-fix.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/durable-objects/api/storage-api/ https://jun-do-raw-iterator-docs-fix.preview.developers.cloudflare.com/durable-objects/api/storage-api/

@Oxyjun Oxyjun merged commit 862552a into production Apr 23, 2025
14 checks passed
@Oxyjun Oxyjun deleted the jun/do/raw-iterator-docs-fix branch April 23, 2025 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pedrosousa pedrosousa pedrosousa approved these changes

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton is a code owner

@joshthoward joshthoward Awaiting requested review from joshthoward joshthoward is a code owner

@harshil1712 harshil1712 Awaiting requested review from harshil1712 harshil1712 is a code owner

Assignees

@elithrar elithrar

@joshthoward joshthoward

@vy-ton vy-ton

@harshil1712 harshil1712

@Oxyjun Oxyjun

Labels

product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ size/xs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Oxyjun @pedrosousa @elithrar @joshthoward @vy-ton @harshil1712